# 指定文件编码为UTF-8
# coding: utf-8

"""
layers.py 功能说明：
1. 实现神经网络的各种层结构
2. 包含前向传播和反向传播计算
3. 支持卷积神经网络和全连接网络
4. 提供常用的激活函数和正则化方法

主要包含的层类型：
1. 激活函数层：ReLU、Sigmoid
2. 全连接层：Affine
3. 损失函数层：SoftmaxWithLoss
4. 正则化层：Dropout、BatchNormalization
5. 卷积网络层：Convolution、Pooling

关键点：
- 所有层都实现forward和backward方法
- 支持批量数据处理
- 卷积层使用im2col优化计算
- 包含训练和测试两种模式
- 实现梯度计算用于参数更新
"""

# 导入NumPy数值计算库
import numpy as np
# 从common.functions导入激活函数和损失函数
from common.functions import *
# 从common.util导入图像到矩阵的转换函数
from common.util import im2col, col2im

class Relu:
    """ReLU激活函数层"""
    def __init__(self):
        self.mask = None  # 记录小于等于0的位置

    def forward(self, x):
        """前向传播"""
        self.mask = (x <= 0)  # 记录输入小于等于0的位置
        out = x.copy()  # 复制输入数据
        out[self.mask] = 0  # 将小于等于0的位置置0
        return out

    def backward(self, dout):
        """反向传播"""
        dout[self.mask] = 0  # 将对应位置的梯度置0
        dx = dout  # 梯度直接传递
        return dx

class Sigmoid:
    """Sigmoid激活函数层"""
    def __init__(self):
        self.out = None  # 保存输出结果

    def forward(self, x):
        """前向传播"""
        out = sigmoid(x)  # 计算sigmoid函数值
        self.out = out  # 保存输出结果
        return out

    def backward(self, dout):
        """反向传播"""
        dx = dout * (1.0 - self.out) * self.out  # 计算梯度
        return dx

class Affine:
    """全连接层"""
    def __init__(self, W, b):
        self.W = W  # 权重矩阵
        self.b = b  # 偏置向量
        self.x = None  # 输入数据
        self.original_x_shape = None  # 输入数据的原始形状
        self.dW = None  # 权重的梯度
        self.db = None  # 偏置的梯度

    def forward(self, x):
        """前向传播"""
        self.original_x_shape = x.shape  # 保存输入形状
        x = x.reshape(x.shape[0], -1)  # 展平输入数据
        self.x = x  # 保存输入数据
        out = np.dot(self.x, self.W) + self.b  # 计算全连接层输出
        return out

    def backward(self, dout):
        """反向传播"""
        dx = np.dot(dout, self.W.T)  # 计算输入梯度
        self.dW = np.dot(self.x.T, dout)  # 计算权重梯度
        self.db = np.sum(dout, axis=0)  # 计算偏置梯度
        dx = dx.reshape(*self.original_x_shape)  # 恢复输入数据的形状
        return dx

class SoftmaxWithLoss:
    """Softmax与交叉熵损失层"""
    def __init__(self):
        self.loss = None  # 损失值
        self.y = None  # softmax输出
        self.t = None  # 真实标签

    def forward(self, x, t):
        """前向传播"""
        self.t = t  # 保存真实标签
        self.y = softmax(x)  # 计算softmax
        self.loss = cross_entropy_error(self.y, self.t)  # 计算交叉熵损失
        return self.loss

    def backward(self, dout=1):
        """反向传播"""
        batch_size = self.t.shape[0]  # 获取批量大小
        if self.t.size == self.y.size:  # 如果标签是one-hot编码
            dx = (self.y - self.t) / batch_size  # 计算梯度
        else:
            dx = self.y.copy()  # 复制输出
            dx[np.arange(batch_size), self.t] -= 1  # 调整正确类别的梯度
            dx = dx / batch_size  # 平均梯度
        return dx

class Dropout:
    """Dropout正则化层"""
    def __init__(self, dropout_ratio=0.5):
        self.dropout_ratio = dropout_ratio  # 丢弃比例
        self.mask = None  # 掩码矩阵

    def forward(self, x, train_flg=True):
        """前向传播"""
        if train_flg:  # 训练模式
            self.mask = np.random.rand(*x.shape) > self.dropout_ratio  # 生成随机掩码
            return x * self.mask  # 应用掩码
        else:  # 测试模式
            return x * (1.0 - self.dropout_ratio)  # 缩放输出

    def backward(self, dout):
        """反向传播"""
        return dout * self.mask  # 应用相同的掩码

class BatchNormalization:
    """批量归一化层"""
    def __init__(self, gamma, beta, momentum=0.9, running_mean=None, running_var=None):
        self.gamma = gamma  # 缩放参数
        self.beta = beta  # 平移参数
        self.momentum = momentum  # 动量参数
        self.input_shape = None  # 输入形状
        self.running_mean = running_mean  # 测试时使用的均值
        self.running_var = running_var  # 测试时使用的方差
        self.batch_size = None  # 批量大小
        self.xc = None  # 中心化后的数据
        self.std = None  # 标准差
        self.dgamma = None  # gamma的梯度
        self.dbeta = None  # beta的梯度

    def forward(self, x, train_flg=True):
        """前向传播"""
        self.input_shape = x.shape  # 保存输入形状
        if x.ndim != 2:  # 如果不是二维数据(全连接层)
            N, C, H, W = x.shape  # 获取形状参数
            x = x.reshape(N, -1)  # 展平数据
        out = self.__forward(x, train_flg)  # 调用内部前向传播
        return out.reshape(*self.input_shape)  # 恢复原始形状

    def __forward(self, x, train_flg):
        """内部前向传播实现"""
        if self.running_mean is None:  # 第一次初始化
            N, D = x.shape
            self.running_mean = np.zeros(D)
            self.running_var = np.zeros(D)

        if train_flg:  # 训练模式
            mu = x.mean(axis=0)  # 计算均值
            xc = x - mu  # 中心化
            var = np.mean(xc**2, axis=0)  # 计算方差
            std = np.sqrt(var + 10e-7)  # 计算标准差(加小值防止除0)
            xn = xc / std  # 标准化

            # 保存中间结果
            self.batch_size = x.shape[0]
            self.xc = xc
            self.xn = xn
            self.std = std
            # 更新运行均值方差
            self.running_mean = self.momentum * self.running_mean + (1-self.momentum) * mu
            self.running_var = self.momentum * self.running_var + (1-self.momentum) * var
        else:  # 测试模式
            xc = x - self.running_mean  # 使用运行均值中心化
            xn = xc / ((np.sqrt(self.running_var + 10e-7)))  # 使用运行方差标准化

        out = self.gamma * xn + self.beta  # 缩放和平移
        return out

    def backward(self, dout):
        """反向传播"""
        if dout.ndim != 2:  # 如果不是二维数据(全连接层)
            N, C, H, W = dout.shape
            dout = dout.reshape(N, -1)  # 展平数据

        dx = self.__backward(dout)  # 调用内部反向传播
        return dx.reshape(*self.input_shape)  # 恢复原始形状

    def __backward(self, dout):
        """内部反向传播实现"""
        dbeta = dout.sum(axis=0)  # beta的梯度
        dgamma = np.sum(self.xn * dout, axis=0)  # gamma的梯度
        dxn = self.gamma * dout  # 标准化输出的梯度
        dxc = dxn / self.std  # 中心化输出的梯度
        dstd = -np.sum((dxn * self.xc) / (self.std * self.std), axis=0)
        dvar = 0.5 * dstd / self.std
        dxc += (2.0 / self.batch_size) * self.xc * dvar
        dmu = np.sum(dxc, axis=0)
        dx = dxc - dmu / self.batch_size

        self.dgamma = dgamma
        self.dbeta = dbeta

        return dx

class Convolution:
    """卷积层"""
    def __init__(self, W, b, stride=1, pad=0):
        self.W = W  # 卷积核(滤波器)
        self.b = b  # 偏置
        self.stride = stride  # 步长
        self.pad = pad  # 填充
        self.x = None  # 输入数据
        self.col = None  # 展开后的输入
        self.col_W = None  # 展开的权重
        self.dW = None  # 权重的梯度
        self.db = None  # 偏置的梯度

    def forward(self, x):
        """前向传播"""
        FN, C, FH, FW = self.W.shape  # 滤波器参数
        N, C, H, W = x.shape  # 输入数据形状
        # 计算输出高度和宽度
        out_h = 1 + int((H + 2*self.pad - FH) / self.stride)
        out_w = 1 + int((W + 2*self.pad - FW) / self.stride)

        col = im2col(x, FH, FW, self.stride, self.pad)  # 展开输入数据
        col_W = self.W.reshape(FN, -1).T  # 展开滤波器

        out = np.dot(col, col_W) + self.b  # 计算卷积结果
        # 调整输出形状
        out = out.reshape(N, out_h, out_w, -1).transpose(0, 3, 1, 2)

        # 保存中间结果
        self.x = x
        self.col = col
        self.col_W = col_W

        return out

    def backward(self, dout):
        """反向传播"""
        FN, C, FH, FW = self.W.shape
        dout = dout.transpose(0,2,3,1).reshape(-1, FN)  # 调整梯度形状

        self.db = np.sum(dout, axis=0)  # 计算偏置梯度
        self.dW = np.dot(self.col.T, dout)  # 计算权重梯度
        self.dW = self.dW.transpose(1, 0).reshape(FN, C, FH, FW)  # 调整形状

        dcol = np.dot(dout, self.col_W.T)  # 计算展开输入的梯度
        dx = col2im(dcol, self.x.shape, FH, FW, self.stride, self.pad)  # 恢复梯度形状

        return dx

class Pooling:
    """池化层"""
    def __init__(self, pool_h, pool_w, stride=1, pad=0):
        self.pool_h = pool_h  # 池化窗口高度
        self.pool_w = pool_w  # 池化窗口宽度
        self.stride = stride  # 步长
        self.pad = pad  # 填充
        self.x = None  # 输入数据
        self.arg_max = None  # 最大值位置

    def forward(self, x):
        """前向传播"""
        N, C, H, W = x.shape  # 输入形状
        # 计算输出高度和宽度
        out_h = int(1 + (H - self.pool_h) / self.stride)
        out_w = int(1 + (W - self.pool_w) / self.stride)

        col = im2col(x, self.pool_h, self.pool_w, self.stride, self.pad)  # 展开输入
        col = col.reshape(-1, self.pool_h*self.pool_w)  # 调整形状

        self.arg_max = np.argmax(col, axis=1)  # 记录最大值位置
        out = np.max(col, axis=1)  # 取最大值
        out = out.reshape(N, out_h, out_w, C).transpose(0, 3, 1, 2)  # 调整输出形状

        self.x = x  # 保存输入
        return out

    def backward(self, dout):
        """反向传播"""
        dout = dout.transpose(0, 2, 3, 1)  # 调整梯度形状

        pool_size = self.pool_h * self.pool_w  # 池化窗口大小
        # 创建梯度矩阵
        dmax = np.zeros((dout.size, pool_size))
        # 只在最大值位置设置梯度
        dmax[np.arange(self.arg_max.size), self.arg_max.flatten()] = dout.flatten()
        dmax = dmax.reshape(dout.shape + (pool_size,))

        dcol = dmax.reshape(dmax.shape[0] * dmax.shape[1] * dmax.shape[2], -1)  # 展开梯度
        dx = col2im(dcol, self.x.shape, self.pool_h, self.pool_w, self.stride, self.pad)  # 恢复梯度形状
        
        return dx
